/*
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you under the Apache License, Version 2.0 (the
 *  "License"); you may not use this file except in compliance
 *  with the License.  You may obtain a copy of the License at
 *
 *  http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing,
 *  software distributed under the License is distributed on an
 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *  KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations
 *  under the License.
 */
package org.apache.myfaces.test.webapp.api.tester;

import org.jboss.shrinkwrap.api.Archive;

import javax.faces.component.UIViewRoot;
import javax.faces.context.FacesContext;
import javax.faces.event.PhaseId;

/**
 * @author Cosmin Martinconi, 05.08.2010
 */
public interface WebappTester {

    public Archive<?> createArchive(Archive<?> applicationArchive);

    public void setUpTestMethod();
    public void tearDownTestMethod();
    public void executeTestMethod();

    public FacesContext getFacesContext();
    public UIViewRoot getRoot();

    public Input input(String value);
    public void click(String clientId);

    public Assertable assertThat(Object injectedAssertableValue);
    public Call expectCall(Object injectedAssertableValue);
    public Call expectLastCall();

    public interface Assertable {
        public PhaseAware is(String expectedValue);
    }

    public interface PhaseAware {
        public void after(PhaseId phase);
        public void before(PhaseId phase);
    }

    public interface Input {
        public void into(String clientId);
    }

    public interface Call {
        public void in(PhaseId phase);
    }
}
